/*
 * Copyright (c) 2008-2018 Haulmont.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.haulmont.cuba.gui.components;

import com.haulmont.cuba.gui.meta.PropertyType;
import com.haulmont.cuba.gui.meta.StudioComponent;
import com.haulmont.cuba.gui.meta.StudioProperty;

/**
 * Component shows if CapsLock key is enabled when user inputs password.
 */
@StudioComponent(icon = "icon/capsLockIndicator.svg",
        unsupportedProperties = {"enable", "responsive"},
        category = "Components",
        documentationURL = "https://doc.cuba-platform.com/manual-%VERSION%/gui_CapsLockIndicator.html")
public interface CapsLockIndicator extends Component {
    String NAME = "capsLockIndicator";

    /**
     * Sets the message that will be shown when caps lock key is active.
     *
     * @param capsLockOnMessage text message
     */
    @StudioProperty(type = PropertyType.LOCALIZED_STRING)
    void setCapsLockOnMessage(String capsLockOnMessage);

    /**
     * @return message that is shown when caps lock key is active
     */
    String getCapsLockOnMessage();

    /**
     * Sets the message that will be shown when caps lock key is not active.
     *
     * @param capsLockOffMessage text message
     */
    @StudioProperty(type = PropertyType.LOCALIZED_STRING)
    void setCapsLockOffMessage(String capsLockOffMessage);

    /**
     * @return message that is shown when caps lock key is not active
     */
    String getCapsLockOffMessage();
}
